common.json

{
  "swagger": "2.0",
  "info": {
    "title": "Mixed Reality",
    "description": "Mixed Reality Resource Provider API",
    "version": "2021-01-01"
  },
  "paths": {},
  "definitions": {
    "AccountKeys": {
      "description": "Developer Keys of account",
      "type": "object",
      "properties": {
        "primaryKey": {
          "x-ms-secret": true,
          "description": "value of primary key.",
          "readOnly": true,
          "type": "string"
        },
        "secondaryKey": {
          "x-ms-secret": true,
          "description": "value of secondary key.",
          "readOnly": true,
          "type": "string"
        }
      }
    },
    "AccountKeyRegenerateRequest": {
      "description": "Request for account key regeneration",
      "type": "object",
      "properties": {
        "serial": {
          "type": "integer",
          "enum": [
            1,
            2
          ],
          "default": 1,
          "x-ms-enum": {
            "name": "Serial",
            "values": [
              {
                "value": 1,
                "description": "The Primary Key",
                "name": "Primary"
              },
              {
                "value": 2,
                "description": "The Secondary Key",
                "name": "Secondary"
              }
            ]
          },
          "description": "serial of key to be regenerated"
        }
      }
    },
    "CloudError": {
      "x-ms-external": true,
      "properties": {
        "error": {
          "description": "An Error response.",
          "$ref": "#/definitions/CloudErrorBody"
        }
      },
      "description": "An Error response."
    },
    "CloudErrorBody": {
      "x-ms-external": true,
      "properties": {
        "code": {
          "type": "string",
          "description": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically."
        },
        "message": {
          "type": "string",
          "description": "A message describing the error, intended to be suitable for displaying in a user interface."
        },
        "target": {
          "type": "string",
          "description": "The target of the particular error. For example, the name of the property in error."
        },
        "details": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/CloudErrorBody"
          },
          "description": "A list of additional details about the error."
        }
      },
      "description": "An error response from Azure."
    },
    "MixedRealityAccountProperties": {
      "description": "Common Properties shared by Mixed Reality Accounts",
      "type": "object",
      "properties": {
        "storageAccountName": {
          "description": "The name of the storage account associated with this accountId",
          "type": "string"
        },
        "accountId": {
          "description": "unique id of certain account.",
          "readOnly": true,
          "type": "string"
        },
        "accountDomain": {
          "description": "Correspond domain name of certain Spatial Anchors Account",
          "readOnly": true,
          "type": "string"
        }
      }
    }
  },
  "parameters": {
    "accountKeyRegenerateParameter": {
      "name": "regenerate",
      "in": "body",
      "required": true,
      "schema": {
        "$ref": "#/definitions/AccountKeyRegenerateRequest"
      },
      "x-ms-parameter-location": "method",
      "description": "Required information for key regeneration."
    },
    "accountNameParameter": {
      "name": "accountName",
      "in": "path",
      "required": true,
      "type": "string",
      "pattern": "^[-\\w\\._\\(\\)]+$",
      "minLength": 1,
      "maxLength": 90,
      "x-ms-parameter-location": "method",
      "description": "Name of an Mixed Reality Account."
    },
    "apiVersionParameter": {
      "name": "api-version",
      "description": "The API version to be used with the HTTP request.",
      "in": "query",
      "required": true,
      "type": "string"
    },
    "locationParameter": {
      "name": "location",
      "in": "path",
      "required": true,
      "type": "string",
      "pattern": "^[-\\w\\._\\(\\)]+$",
      "minLength": 1,
      "maxLength": 90,
      "x-ms-parameter-location": "method",
      "description": "The location in which uniqueness will be verified."
    },
    "resourceGroupNameParameter": {
      "name": "resourceGroupName",
      "in": "path",
      "required": true,
      "type": "string",
      "pattern": "^[-\\w\\._\\(\\)]+$",
      "minLength": 1,
      "maxLength": 90,
      "x-ms-parameter-location": "method",
      "description": "Name of an Azure resource group."
    },
    "subscriptionIdParameter": {
      "name": "subscriptionId",
      "description": "The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000)",
      "in": "path",
      "required": true,
      "type": "string"
    }
  }
}